package io.github.cocoa.module.socket.service.sample;

import io.github.cocoa.framework.common.pojo.CommonResult;
import io.github.cocoa.framework.common.pojo.PageResult;
import io.github.cocoa.module.socket.controller.admin.sample.vo.*;
import io.github.cocoa.module.socket.dal.dataobject.sample.SampleInfoDO;
import io.github.cocoa.module.system.api.mail.dto.MailSendSingleToUserReqDTO;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 示例信息 Service 接口
 *
 * @author James
 */
public interface SampleInfoService {

    /**
     * 创建示例信息
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createInfo(@Valid SampleInfoCreateReqVO createReqVO);

    /**
     * 更新示例信息
     *
     * @param updateReqVO 更新信息
     */
    void updateInfo(@Valid SampleInfoUpdateReqVO updateReqVO);

    /**
     * 删除示例信息
     *
     * @param id 编号
     */
    void deleteInfo(Long id);

    /**
     * 获得示例信息
     *
     * @param id 编号
     * @return 示例信息
     */
    SampleInfoDO getInfo(Long id);

    /**
     * 获得示例信息列表
     *
     * @param ids 编号
     * @return 示例信息列表
     */
    List<SampleInfoDO> getInfoList(Collection<Long> ids);

    /**
     * 获得示例信息分页
     *
     * @param pageReqVO 分页查询
     * @return 示例信息分页
     */
    PageResult<SampleInfoDO> getInfoPage(SampleInfoPageReqVO pageReqVO);

    /**
     * 获得示例信息列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 示例信息列表
     */
    List<SampleInfoDO> getInfoList(SampleInfoExportReqVO exportReqVO);

    /**
     * 批量导入示例信息列表
     *
     * @param importInfoList  导入示例信息列表
     * @param isUpdateSupport 是否支持更新
     * @return 导入结果
     */
    SampleInfoImportRespVO importInfoList(List<SampleInfoImportExcelVO> importInfoList, Boolean isUpdateSupport);

    /**
     * 发送单条邮件给 Admin 用户
     *
     * @param reqDTO 邮件发送给 Admin 或者 Member 用户 Request DTO
     * @return 发送日志编号
     */
    CommonResult<Long> sendSingleMailToAdmin(MailSendSingleToUserReqDTO reqDTO);

    /**
     * 发送示例信息消息
     */
    Long sendSampleInfoMessage();

    /**
     * 发送示例信息消息 - 方法一
     */
    Long oneMethodMessage();

    /**
     * 发送示例信息消息 - 方法二
     */
    Long twoMethodMessage();

}
